chore: update project memories with latest codebase state(1.8.0)#2998
chore: update project memories with latest codebase state(1.8.0)#2998
Conversation
- Refresh all 8 memories to reflect current code (v1.7.0) - Remove all PR number references (derivable from git history) - Remove "Key Recent Changes" changelog section - Remove CI implementation details (rerun delay/count) - Describe current behavior as facts, not change events - Mark legacy backends as excluded from Serena context - Add GraphSpace, Swagger UI, TTL update, bridge networking info chore: add .mcp.json to .gitignore fix: keep .serena/memories/ and project.yml tracked in git
There was a problem hiding this comment.
Pull request overview
Updates repository “project memories” / Serena configuration to reflect the current HugeGraph codebase and CI layout, plus refreshes README CI badges.
Changes:
- Update README badges to reflect current GitHub Actions workflows.
- Expand
.serena/project.ymlwith richer ignore patterns and newer Serena config options. - Rewrite/condense multiple
.serena/memories/*.mddocuments (commands, module map, conventions, architecture, ecosystem).
Reviewed changes
Copilot reviewed 10 out of 11 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
README.md |
Updates CI badges to point at server-ci.yml and pd-store-ci.yml. |
.serena/project.yml |
Updates Serena project config: language list comments, ignore paths, and new config keys. |
.serena/memories/task_completion_checklist.md |
Condenses checklist into a shorter “quality/tests/deps/CI/commit” format. |
.serena/memories/suggested_commands.md |
Reorganizes common build/test/validation/docker commands into a shorter reference. |
.serena/memories/project_overview.md |
Refreshes high-level project description, capabilities, and version summary. |
.serena/memories/key_file_locations.md |
Updates “map” of important directories and CI workflows. |
.serena/memories/implementation_patterns_and_guidelines.md |
Updates implementation notes (backends, GraphSpace, auth, CI, docker). |
.serena/memories/ecosystem_and_related_projects.md |
Rewrites ecosystem overview into a compact table + integration summary. |
.serena/memories/code_style_and_conventions.md |
Condenses style/convention notes and points to key enforcement tools. |
.serena/memories/architecture_and_modules.md |
Simplifies architecture + module structure summary. |
.gitignore |
Stops ignoring all of .serena/ wholesale; keeps project.yml and memories/ tracked while ignoring other .serena/*. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Remove content duplicated in README.md (project overview, architecture, module tables, code style, CI profiles). Focus test examples on active backends (RocksDB/memory) only. Strip hardcoded version numbers. Keep unique development workflows (dependency compliance, gRPC, auth, debugging). 262 lines → 120 lines (54% reduction, zero duplication). refactor(docs): remove non-development sections from AGENTS.md Remove debugging tips (ops tools), authentication system description, Docker Compose references, and ecosystem section. 120 → 103 lines.
VGalaxies
left a comment
There was a problem hiding this comment.
Review findings from local audit.
| ignored_paths: | ||
| # --- Deprecated backends (focus on RocksDB/HStore only) --- | ||
| - "hugegraph-server/hugegraph-cassandra/**" | ||
| - "hugegraph-server/hugegraph-scylladb/**" | ||
| - "hugegraph-server/hugegraph-mysql/**" | ||
| - "hugegraph-server/hugegraph-postgresql/**" | ||
| - "hugegraph-server/hugegraph-palo/**" | ||
| - "hugegraph-server/hugegraph-hbase/**" | ||
| # --- gRPC generated Java (235k lines, never hand-edited, regenerated by mvn compile) --- | ||
| - "hugegraph-pd/hg-pd-grpc/src/main/java/**" | ||
| - "hugegraph-store/hg-store-grpc/src/main/java/**" | ||
| # --- License/legal files (585 txt files, only touched when adding dependencies) --- | ||
| - "install-dist/release-docs/licenses/**" | ||
| - "install-dist/scripts/dependency/known-dependencies.txt" | ||
| # --- Rarely modified tests/examples --- | ||
| - "hugegraph-server/hugegraph-test/**/tinkerpop/**" | ||
| - "hugegraph-server/hugegraph-example/**" | ||
| - "hugegraph-cluster-test/**" |
There was a problem hiding this comment.
This ignore list now removes HBase, cluster tests, and the dependency-compliance paths from Serena's project view. That is broader than 'dead/generated code': the repo still ships hugegraph-hbase, still runs hbase in server CI, still contains hugegraph-cluster-test, and AGENTS.md explicitly requires updating the license and known-dependencies.txt files when adding third-party dependencies. With this config, Serena-based agents will miss or be unable to complete those tasks.
There was a problem hiding this comment.
This ignore list now removes HBase, cluster tests, and the dependency-compliance paths from Serena's project view. That is broader than 'dead/generated code': the repo still ships
hugegraph-hbase, still runshbasein server CI, still containshugegraph-cluster-test, andAGENTS.mdexplicitly requires updating the license andknown-dependencies.txtfiles when adding third-party dependencies. With this config, Serena-based agents will miss or be unable to complete those tasks.
Yes, no need to add HBase related files as the context in the future work (from 1.8.0)
And the memory system(like serena) should focus on the main files (shouldn't include deps/license file) even they might change
| ## Key Architectural Patterns | ||
|
|
||
| Apache HugeGraph is a fast-speed and highly-scalable graph database that supports billions of vertices and edges. It is compliant with Apache TinkerPop 3 and supports both Gremlin and Cypher query languages. | ||
| 1. **Pluggable Backend Architecture**: Storage backends implement the `BackendStore` interface — new backends require no core changes. Active backends: RocksDB (default/embedded), HStore (distributed) |
There was a problem hiding this comment.
The condensed guide now presents RocksDB/HStore as the only active backends, which conflicts with the current tree: hugegraph-hbase is still a server module and server-ci.yml still tests the hbase backend. Agents following this summary will route HBase work away as unsupported/legacy, which is not the current project state.
There was a problem hiding this comment.
The condensed guide now presents RocksDB/HStore as the only active backends, which conflicts with the current tree:
hugegraph-hbaseis still a server module andserver-ci.ymlstill tests thehbasebackend. Agents following this summary will route HBase work away as unsupported/legacy, which is not the current project state.
Same reason, focus on the main/core backend
… docs - Add Development Conventions section: require test coverage for all code changes - Expand Code Quality section with pre-commit checklist and .editorconfig summary - Add Reference Documents section pointing to README and .serena/memories - Link hugegraph-pd/store module names to their READMEs in root README Update .gitignore
| # Use Maven's -Dtest parameter | ||
| mvn test -pl hugegraph-server/hugegraph-test -am -P core-test,memory -Dtest=YourTestClass | ||
| mvn install -pl hugegraph-struct -am -DskipTests | ||
| mvn test -pl hugegraph-pd/hg-pd-test -am # or hg-store-test |
There was a problem hiding this comment.
Can we spell out the Store test command here instead of relying on # or hg-store-test? Agents will likely copy the line literally, so adding mvn test -pl hugegraph-store/hg-store-test -am would make PD/Store coverage unambiguous.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2998 +/- ##
============================================
+ Coverage 35.65% 36.08% +0.42%
- Complexity 333 403 +70
============================================
Files 802 811 +9
Lines 67731 68219 +488
Branches 8844 8904 +60
============================================
+ Hits 24147 24614 +467
+ Misses 40995 40986 -9
- Partials 2589 2619 +30 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
- Restore architecture diagram, top-level module map, server submodule list, code search anchors, and commit format so AGENTS.md is self-sufficient as the default AI context file - Drop low-entropy sections: "Development Conventions" platitude, single-line gRPC heading, duplicated script listing - Spell out both PD and Store test commands instead of relying on a "# or hg-store-test" comment (per @VGalaxies review) - Remove hbase swap option in the Core test row for consistency with the "focus on core backend" stance
Purpose of the PR
Keep the project's memory clean & useful